docs(web): update README with shipped routing/pages/context; expand CHANGELOG Web bullet#20
Closed
cursor[bot] wants to merge 1 commit into
Closed
docs(web): update README with shipped routing/pages/context; expand CHANGELOG Web bullet#20cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
…pand CHANGELOG Web bullet - Replace stale 'PR split / suggested follow-ups' section in web/README.md with accurate architecture docs covering the shipped HashRouter setup, three named pages (OverviewPage, DiffPage, ActionsPage), API helpers in api.ts, and the TimelineRefreshContext pattern. - Add route/URL/component/nav-label mapping table so contributors know that the 'Promote' nav link maps to /#/actions and ActionsPage, not a literal /promote route. - Expand the CHANGELOG Unreleased 'Web + E2E' bullet to name HashRouter, the three pages with their hash routes, TimelineRefreshContext mechanics, and Playwright smoke coverage. Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Keep
web/README.mdandCHANGELOG.mdaligned with the app shell routing that shipped in commit8f35e9a590db.Why
The
web/README.mdstill described React Router as a future "PR C — Optional" item, even thoughHashRouter, three named pages,TimelineRefreshContext, and full API helpers had already landed. Contributors reading the file got a misleading picture of the current codebase.Changes
web/README.md— replaced the stale "PR split / Suggested follow-ups" section with an "App structure" section covering:HashRouterwith a route/URL hash/component/nav-label mapping table (clarifies that nav "Promote" = route/#/actions=ActionsPage, not a literal/promoteroute)OverviewPage(read+auto-refresh),DiffPage(diff form + metrics),ActionsPage(promote/rollback mutations)api.ts(fetchJson,loadTimeline, type exports)TimelineRefreshContextpattern and mutation flowCHANGELOG.md— expanded the Unreleased "Web + E2E" bullet to nameHashRouter, three hash routes,TimelineRefreshContextmechanics, and Playwright smoke coverage scope.Validation
uv sync --frozen --extra devuv run python -m ruff check src tests— cleanuv run python -m pytestuv run flightdeck-quickstart-verifyuv run flightdeck --helpSchema / Storage Impact
Risk
Documentation-only. No code paths changed.
Review